|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.ftxml.MXSSearch
This class permits sequential searching of multiple catalogs with the same query.
CatalogSearch
Field Summary | |
static java.lang.String |
stdLog
|
Constructor Summary | |
MXSSearch(java.lang.String[] catPathList)
API: Constructor for class MXSSearch taking path and list of catalog names. |
|
MXSSearch(java.lang.String[] catPathList,
com.doclinx.jftr.Log log)
API: Constructor for class MXSSearch taking path and list of catalog names. |
|
MXSSearch(java.lang.String[] catPathList,
java.lang.String logFile,
int logLevel)
API: Constructor for class MXSSearch taking path and list of catalog names. |
|
MXSSearch(java.lang.String path,
java.lang.String catList)
API: Constructor for class MXSSearch taking path and list of catalog names. |
|
MXSSearch(java.lang.String path,
java.lang.String catList,
com.doclinx.jftr.Log log)
API: Constructor for class MXSSearch taking path and list of catalog names. |
|
MXSSearch(java.lang.String path,
java.lang.String catList,
java.lang.String logFile,
int logLevel)
API: Constructor for class MXSSearch taking path and list of catalog names. |
Method Summary | |
void |
close()
API: Close multiple catalog search object. |
int |
dbCount()
API: Close multiple catalog search object. |
int |
dbHitCount()
API: Calculates the number of catalogs that matched that last query. |
long |
docCount()
API: Obtains the number of documents matching the last search. |
long |
docCount(int db)
API: Obtains the number of documents matching the last search for the given catalog. |
void |
finalize()
Override default finalize to ensure multiple catalog search handle closed. |
com.doclinx.ftxml.CatalogManager |
getCatalog(int db)
API: Returns the CatalogItem data for the hit specified by the dh parameter. |
com.doclinx.jftr.DBDOCHIT[] |
getDocList(int[] sList,
int start,
int n)
API: Returns the DB DOCHIT list of all the document hits matching the last query. |
com.doclinx.jftr.DBDOCHIT[] |
getDocList(int[] sList,
int start,
int n,
java.lang.String[] keys)
API: Returns the DB DOCHIT list of all the document hits matching the last query. |
com.doclinx.jftr.DBDOCHIT[] |
getDocList(int[] sList,
int start,
int n,
java.lang.String[] keys,
boolean sortWithinCatalog)
API: Returns the DB DOCHIT list of all the document hits matching the last query. |
com.doclinx.jftr.DBDOCHIT[] |
getDocList(int start,
int n)
API: Returns the DB DOCHIT list of all the document hits matching the last query. |
com.doclinx.jftr.DBDOCHIT[] |
getDocList(int start,
int n,
java.lang.String[] keys)
API: Returns the DB DOCHIT list of all the document hits matching the last query. |
com.doclinx.ftxml.CatalogItem |
getEntry(com.doclinx.jftr.DBDOCHIT dh)
API: Returns the CatalogItem data for the hit specified by the dh parameter. |
java.lang.String |
getName(com.doclinx.jftr.DBDOCHIT dh)
API: Obtains the name of a catalog (without path) for specified DBDOCHIT. |
java.lang.String |
getPDFHighlight(com.doclinx.jftr.DBDOCHIT dh)
API: Get PDF highlight file format String for specified document hit. |
java.util.Vector |
getWildcardLookup(com.doclinx.jftr.DBDOCHIT dh)
API: Return the specific match(es) to a wildcard search for a specific document. |
java.util.Vector[] |
getWildcardLookup(com.doclinx.jftr.DBDOCHIT[] dh,
java.lang.String sep)
API: Return the specific match(es) to a wildcard search for a document hit list. |
java.util.Vector |
getWildcardLookup(com.doclinx.jftr.DBDOCHIT dh,
java.lang.String sep)
API: Return the specific match(es) to a wildcard search for a specific document. |
long |
hitCount()
API: Obtains the total number of hits matching the search. |
long |
maxCount()
API: Obtains the total number of documents in all the catalogs. |
void |
search(java.lang.String query)
API: Perform search on all the databases using the specified query. |
void |
search(java.lang.String query,
boolean errNoXPath)
API: Perform search on all the databases using the specified query. |
long |
searchTime()
API: Provides the time required to perform last search. |
void |
setDateFormats(java.lang.String dateFormats)
API: Set the date formats to use for document sorting of metadata. |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String stdLog
Constructor Detail |
public MXSSearch(java.lang.String path, java.lang.String catList) throws CatalogSearchException
path
- Absolute path of the catalog directory.catList
- List of comma delimted catalog names.
CatalogSearchException
- See constant
definitions.public MXSSearch(java.lang.String path, java.lang.String catList, java.lang.String logFile, int logLevel) throws CatalogSearchException
path
- Absolute path of the catalog directory.catList
- List of comma delimted catalog names.logFile
- Filename for common log file.logLevel
- Severity level, see debug
settings.
CatalogSearchException
- See constant
definitions.public MXSSearch(java.lang.String path, java.lang.String catList, com.doclinx.jftr.Log log) throws CatalogSearchException
path
- Absolute path of the catalog directory.catList
- List of comma delimted catalog names.log
- Logger to use for logging.
CatalogSearchException
- See constant
definitions.public MXSSearch(java.lang.String[] catPathList) throws CatalogSearchException
catPathList
- Array of String denoting path and catalog names.
CatalogSearchException
- See constant
definitions.public MXSSearch(java.lang.String[] catPathList, java.lang.String logFile, int logLevel) throws CatalogSearchException
catPathList
- Array of String denoting path and catalog names.logFile
- Filename for common log file.logLevel
- Severity level, see debug
settings.
CatalogSearchException
- See constant
definitions.public MXSSearch(java.lang.String[] catPathList, com.doclinx.jftr.Log log) throws CatalogSearchException
catPathList
- Array of String denoting path and catalog names.log
- Logger to use for logging.
CatalogSearchException
- See constant
definitions.Method Detail |
public void finalize()
finalize
in class java.lang.Object
public void close() throws CatalogSearchException
CatalogSearchException
- See constant
definitions.public int dbCount()
public java.lang.String getName(com.doclinx.jftr.DBDOCHIT dh)
dh
- The DBDOCHIT with the catalog index of the required name.
public void search(java.lang.String query) throws CatalogSearchException
query
- Query specifying search criteria.
CatalogSearchException
- See constant
definitions.public void search(java.lang.String query, boolean errNoXPath) throws CatalogSearchException
query
- Query specifying search criteria.errNoXPath
- Throw error exception if any xpath not found.
CatalogSearchException
- See constant
definitions.public long maxCount()
public long docCount() throws CatalogSearchException
CatalogSearchException
- See constant
definitions.public long docCount(int db) throws CatalogSearchException
db
- Index of the catalog
CatalogSearchException
- See constant
definitions.public long hitCount() throws CatalogSearchException
CatalogSearchException
- See constant
definitions.public int dbHitCount() throws CatalogSearchException
CatalogSearchException
- See constant
definitions.public long searchTime() throws CatalogSearchException
CatalogSearchException
- See constant
definitions.public com.doclinx.jftr.DBDOCHIT[] getDocList(int start, int n) throws CatalogSearchException
start
- The starting index to begin list. The 1st document hit
is numbered 1.n
- The number of items to return. If n is greater than
remaining items, then just the remaining items are returned.
CatalogSearchException
- See constant
definitions.public com.doclinx.jftr.DBDOCHIT[] getDocList(int start, int n, java.lang.String[] keys) throws CatalogSearchException
start
- The starting index to begin list. The 1st document hit
is numbered 1.n
- The number of items to return. If n is greater than
remaining items, then just the remaining items are returned.keys
- An array of xpaths specifying sort keys. See catXSGetSortedDocList
for sort key definitions. Sorting is across all catalogs.
CatalogSearchException
- See constant
definitions.public com.doclinx.jftr.DBDOCHIT[] getDocList(int[] sList, int start, int n) throws CatalogSearchException
sList
- An array of integers that give the catalog subset to return
for document results. The indexes in this array must be
between 0 and the number of catalogs opened - 1. The subset
also provides the order of return (e.g. catalogs 2,1,3).start
- The starting index to begin list. The 1st document hit
is numbered 1.n
- The number of items to return. If n is greater than
remaining items, then just the remaining items are returned.
CatalogSearchException
- See constant
definitions.public com.doclinx.jftr.DBDOCHIT[] getDocList(int[] sList, int start, int n, java.lang.String[] keys) throws CatalogSearchException
sList
- An array of integers that give the catalog subset to return
for document results. The indexes in this array must be
between 0 and the number of catalogs opened - 1. The subset
also provides the order of return (e.g. catalogs 2,1,3).start
- The starting index to begin list. The 1st document hit
is numbered 1.n
- The number of items to return. If n is greater than
remaining items, then just the remaining items are returned.keys
- An array of xpaths specifying sort keys. See catXSGetSortedDocList
for sort key definitions.
CatalogSearchException
- See constant
definitions.public com.doclinx.jftr.DBDOCHIT[] getDocList(int[] sList, int start, int n, java.lang.String[] keys, boolean sortWithinCatalog) throws CatalogSearchException
sList
- An array of integers that give the catalog subset to return
for document results. The indexes in this array must be
between 0 and the number of catalogs opened - 1. The subset
also provides the order of return (e.g. 2,1,3)start
- The starting index to begin list. The 1st document hit
is numbered 1.n
- The number of items to return. If n is greater than
remaining items, then just the remaining items are returned.keys
- An array of xpaths specifying sort keys. See catXSGetSortedDocList
for sort key definitions.sortWithinCatalog
- If set, sort results catalog-by-catalog in order specified.
If false, results are sorted globally without regard to
order defined by the catalog subset list (sList[]).
CatalogSearchException
- See constant
definitions.public com.doclinx.ftxml.CatalogItem getEntry(com.doclinx.jftr.DBDOCHIT dh) throws CatalogSearchException, CatalogMgrException
dh
- The DBDOCHIT with the catalog index/document number of the required entry.
CatalogSearchException
- See constant
definitions.
CatalogMgrException
- See constant
definitions.public com.doclinx.ftxml.CatalogManager getCatalog(int db) throws CatalogSearchException
db
- Specifies which catalog handle to return.
CatalogSearchException
- See constant
definitions.public void setDateFormats(java.lang.String dateFormats)
dateFormats
- String containing date format list.public java.util.Vector getWildcardLookup(com.doclinx.jftr.DBDOCHIT dh) throws CatalogSearchException
dh
- The DBDOCHIT with the catalog index/document number to match.
CatalogSearchException
- See constant
definitions.public java.util.Vector getWildcardLookup(com.doclinx.jftr.DBDOCHIT dh, java.lang.String sep) throws CatalogSearchException
dh
- The DBDOCHIT with the catalog index/document number to match.sep
- If not null, then return the wildcard, plus the separator plus
the specific match. If null, just return the match.
CatalogSearchException
- See constant
definitions.public java.util.Vector[] getWildcardLookup(com.doclinx.jftr.DBDOCHIT[] dh, java.lang.String sep) throws CatalogSearchException
dh
- The DBDOCHIT List with the catalog index/document numbers to match.sep
- If not null, then return the wildcard, plus the separator plus
the specific match. If null, just return the match.
CatalogSearchException
- See constant
definitions.public java.lang.String getPDFHighlight(com.doclinx.jftr.DBDOCHIT dh) throws CatalogSearchException
dh
- The DBDOCHIT with the catalog index/document for HFF data.
CatalogSearchException
- See constant
definitions.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |